home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 22 / Cream of the Crop 22.iso / program / tdk_v120.zip / SYSOP.DOC < prev    next >
Text File  |  1996-07-23  |  16KB  |  355 lines
  1. * FEEL FREE TO INCLUDE THIS DOCUMENT WITH EVERY DOOR YOU WRITE *
  2.  
  3. * MODIFY AS NEEDED *
  4.  
  5. ───────────────────────────────────────────────────────────────────────────────
  6.    ▀▀▀▀▀▀▀▀  ▀▀▀▀▀▀    ▀▀   ▀▀
  7.      ▀▀     ▀▀   ▀▀   ▀▀  ▀▀
  8.     ▀▀     ▀▀   ▀▀▀  ▀▀▀▀▀  The DoorKit!
  9.    ▀▀     ▀▀   ▀▀   ▀▀  ▀▀
  10.   ▀▀     ▀▀▀▀▀▀    ▀▀    ▀▀
  11.   The BBS Door Development Kit By The People - For The People!
  12. ───────────────────────────────────────────────────────────────────────────────
  13.   The ANSI/ASCII/RIP/MAX DoorKit v1.20
  14.   No Copyright Notices Expressed Or Implied
  15.   Compiled By Larry L. Athey From Numerous Sources
  16. ───────────────────────────────────────────────────────────────────────────────
  17.  
  18.   DISCLAIMER:
  19.   -----------
  20.   The author (Author) has taken every precaution to insure that no harm or
  21.   damage will occur on computer systems operating this package. Nevertheless,
  22.   the author shall NOT be held liable for whatever may happen on your computer
  23.   system or to any computer systems which connects to your own as a result of
  24.   operating this package. The user assumes full responsibility for the correct
  25.   operation of this software package, whether harm or damage results from any
  26.   software error, hardware malfunction, or operator error. NO warranties are
  27.   offered, expressly stated or implied, including without any limitation or
  28.   restriction any warranties of operation for a particular purpose and / or
  29.   merchantability. If you do not agree with this, then absolutely do NOT use
  30.   this program!
  31.  
  32. ───────────────────────────────────────────────────────────────────────────────
  33.  
  34.   LICENSE AGREEMENT:
  35.   ------------------
  36.  
  37.   The door program, support files, and documentation are copyrighted products
  38.   of (Your Software Company). The author reserves all rights to these products.
  39.   This is protected by the United States of America (USA) and International
  40.   Copyright Laws. In no way shall the components of the door software package
  41.   be reproduced or modified in any form or method without prior expressly
  42.   written permission from the author.
  43.  
  44.   Tampering with or altering the contents or integrity of the door software
  45.   package is prohibited. No fee may be charged by any agency other than the
  46.   author beyond the cost of distributing unregistered copies without prior
  47.   expressly written permission from the author.
  48.  
  49.   This door is distributed under the Shareware concept. You are allowed to
  50.   operate this door for a trial period of thirty (30) days. After this trial
  51.   period, you must register the door or discontinue its usage. Again if you
  52.   do not agree with this, then do NOT use this door!
  53.  
  54. ───────────────────────────────────────────────────────────────────────────────
  55.  
  56.   REQUIREMENTS:
  57.   -------------
  58.  
  59.   At this point in time the only requirements are FILES=10 (or more) in your
  60.   CONFIG.SYS file and ANSI.SYS. SHARE.EXE must also be loaded if you intend to
  61.   use the door in a multi-node environment OR under DesqView. The door is 100
  62.   percent ANSI, ASCII and RIP aware. A FOSSIL IS NOT REQUIRED to run this door
  63.   unless you are using a DigiBoard or other type of intelligent I/O Card.
  64.  
  65. ───────────────────────────────────────────────────────────────────────────────
  66.  
  67.   INSTALLATION:
  68.   -------------
  69.  
  70.  1. Create a directory for the door (example: "C:\DOOR").
  71.  
  72.  2. Copy all the contents of this archive into that directory.
  73.  
  74.  3. Run the door configuration program.
  75.  
  76.  4. To insure proper multi-node use in a DOS based multi-tasking environment,
  77.     SHARE.EXE must be installed prior to the door, and prior to the OS.
  78.  
  79.  5. In order to run the door program online, the following parameters may
  80.     be used. For a list of all available command line parameters, simply
  81.     execute the program with no parameters....
  82.  
  83.     "/D={Node Work Path}\DOOR.SYS" - This tells the program to use the
  84.     DOOR.SYS drop file and the {Node Work Path} points to the proper
  85.     directory where the drop file is to be created or found.
  86.  
  87.     "/R={Node Work Path}\DORINFO#.DEF" - This tells the program to use the
  88.     DORINFO#.DEF drop file and the {Node Work Path} points to the proper
  89.     directory where the drop file is to be created or found.
  90.  
  91.     "/S##### (Where ##### is the user's actual baud rate) - This specifies
  92.     the online caller's actual baud rate. You use this parameter to force a
  93.     new baud rate if you are running the door with the DOOR.SYS drop file
  94.     and would like to force the door to use the actual baud rate rather than
  95.     the locked port speed. This will let the door calculate download times
  96.     more accurately.
  97.  
  98.     "/N#" (Where # is 1..?) - This specifies a "Node Number".
  99.  
  100.     "/L" - This tells the door to load up in LOCAL mode.
  101.     
  102. ───────────────────────────────────────────────────────────────────────────────
  103.  
  104.   THE CONTROL FILE EDITOR:
  105.   ------------------------
  106.  
  107.     ┌─────────────────────────────────────────────────────────────────────┐
  108.     │ Editing Control File For Node #1                                    │
  109.     ├─────────────────────────────────────────────────────────────────────┤
  110.     │ SysOp First Name:[Your First Name_____]                             │
  111.     │  SysOp Last Name:[Your Last Name______]                             │
  112.     │ Name Of This BBS:[Your BBS Name___________________________]         │
  113.     │   SysOp Security:[500__]                                            │
  114.     │    Serial Number:[__________]                                       │
  115.     │    BBS Home Path:[C:\SHOTGUN\_]                                     │
  116.     │─────────────────────────────────────────────────────────────────────│
  117.     │     Using Fossil:[Y]         Input Buffer Size:[512_]               │
  118.     │ Locked Port Rate:[38400_]   Output Buffer Size:[1024]               │
  119.     │   Activate FIFOs:[Y]         Non-Standard Port:[N]        Save ▄    │
  120.     │   Comm Data Bits:[8]            Comport Number:[1_]       ▀▀▀▀▀▀    │
  121.     │      Comm Parity:[N]           Port IRQ Number:[4_]       Quit ▄    │
  122.     │   Comm Stop Bits:[1]          Port Hex Address:[03F8]     ▀▀▀▀▀▀    │
  123.     └─────────────────────────────────────────────────────────────────────┘
  124.  
  125.     SysOp First Name: Self Explanatory
  126.      SysOp Last Name: "              "
  127.     Name Of This BBS: "              "
  128.  
  129.       SysOp Security: Set this to the same numeric value as the sysop
  130.                       security level on your BBS.
  131.  
  132.        Serial Number: Enter the serial number here that you are issued
  133.                       when registering this program. Repeat this step
  134.                       for every node.
  135.  
  136.        BBS Home Path: Enter the path to your BBS home directory here.
  137.                       This has nothing to do with drop files, the path
  138.                       to your drop files is passed on the command line.
  139.                       this is used so this program can locate your BBS
  140.                       system data files.
  141.  
  142.         Using Fossil: Are you using a fossil driver? [Y/N]
  143.  
  144.     Locked Port Rate: Enter the speed here in which your comport is
  145.                       locked at. Note: If you are using a fossil driver
  146.                       this must be no higher than 38400 baud. I have
  147.                       yet to see a fossil driver that doesn't ignore
  148.                       locked port rates set higher than 38400 baud.
  149.  
  150.       Activate FIFOs: Do you want this program to use modem FIFOs? [Y/N]
  151.  
  152.       Comm Data Bits: Set to the same as your BBS's Data Bits setting.
  153.  
  154.          Comm Parity: Set to the same as your BBS's Parity setting.
  155.                       N=None, O=Odd, E=Even
  156.  
  157.       Comm Stop Bits: Set to the same as your BBS's Stop Bits setting.
  158.  
  159.    Input Buffer Size: Set this to the same as your BBS or fossil driver.
  160.  
  161.   Output Buffer Size: Set this to the same as your BBS or fossil driver.
  162.  
  163.    Non-Standard Port: Are you using a non-standard IRQ setting? [Y/N]
  164.  
  165.       Comport Number: The comport number for this node (If Non-Standard).
  166.  
  167.      Port IRQ Number: The IRQ number for this node (If Non-Standard).
  168.  
  169.     Port Hex Address: This port's address in hex (If Non-Standard).
  170.  
  171. ───────────────────────────────────────────────────────────────────────────────
  172.  
  173.   SAMPLE BATCH FILES FOR RUNNING THE DOOR:
  174.   ----------------------------------------
  175.   CD\DOOR
  176.   DOOR.EXE /D=C:\BBS\NODE1\DOOR.SYS
  177.   CD\BBS
  178.   EXIT
  179.  
  180.   or:
  181.  
  182.   CD\DOOR
  183.   DOOR.EXE /N2 /S14400 /R=C:\BBS\NODE2\DORINFO2.DEF
  184.   CD\BBS
  185.   EXIT
  186.  
  187. ───────────────────────────────────────────────────────────────────────────────
  188.  
  189.   OTHER GENERAL INFORMATION:
  190.   --------------------------
  191.  
  192.   Global System Variables Used By The Door:
  193.   ─────────────────────────────────────────
  194.   {TIME}      = The Current Time
  195.   {DATE}      = The Current Date
  196.   {NODE}      = The Current Node Number
  197.   {BAUD}      = The Current Baud Rate
  198.   {MINS}      = Time Left Online In Minutes
  199.   {PORT}      = The Current Comm Port In Use
  200.   {SEC}       = The User's Security Level
  201.   {BBS}       = Your BBS Name
  202.   {USER}      = User's Full Name
  203.   {SYSOP}     = SysOp's Full Name
  204.   {UFIRST}    = User's First Name
  205.   {ULAST}     = User's Last Name
  206.   {SFIRST}    = SysOp's First Name
  207.   {SLAST}     = SysOp's Last Name
  208.   {PROG}      = The Program Name and Version Number
  209.   {ADDR}      = The Port Address Stored In The .CTL File
  210.   {IRQ}       = The Port IRQ Stored In The .CTL File
  211.   {SYSSEC}    = SysOp Security Stored In The .CTL File
  212.   {SERIAL}    = The Serial Number Stored In The .CTL File
  213.   {INSERT1}
  214.    Through
  215.   {INSERT5}   = These are system variables that change from
  216.                 time to time through out the program. Check
  217.                 your screen files to see what their purpose
  218.                 is at the time.
  219.  
  220.   These variables can also be used in text files and screen files used by
  221.   your program. Make sure that you save all of your ANSI screens with a
  222.   maximum width of 128 characters per line or less! You will also want to
  223.   look at your ANSI and RIP files with a text editor to make sure that any
  224.   Global System Variables you have used have not been split as this will
  225.   cause them to display incorrectly.
  226.  
  227.   Inline Color Tokens:
  228.   ────────────────────
  229.   Inline Color Tokens are similar to Global System Variables with just one
  230.   exception....They don't work in screen files. These are used for adding
  231.   color to text files. Your ANSI colors range from 0 to 31, any number above
  232.   15 forces ANSI blink on. If you want to change the color anywhere in a text
  233.   file, simply add a color code in a pair of fancy brackets before your text.
  234.   An example would be, to change your text to yellow add the token: {14} just
  235.   before it. You have as many color changes that you can fit into a 128
  236.   character line.
  237.  
  238. ───────────────────────────────────────────────────────────────────────────────
  239.  
  240.   SCREEN FILES:
  241.   -------------
  242.  
  243.   All door programs written using The DoorKit only support ANSI screens that
  244.   are saved with a maximum line length of 128 characters. If you have created
  245.   any screen files in the past, they most likely won't work with this program
  246.   until you load them into an ANSI screen editor and save them again with the
  247.   correct line length.
  248.  
  249.   This only applies to ANSI screen files, RIP files will display normally with
  250.   out any extra editing.
  251.  
  252. ───────────────────────────────────────────────────────────────────────────────
  253.  
  254.   MULTINODE USE:
  255.   --------------
  256.  
  257.   This door supports multinode use and provides automatic multi-tasker
  258.   support (time slice releasing) for a wide variety of multi-taskers.
  259.   Such as DesqView, OS/2, Windows, Double-Dos, and Novell Netware. You
  260.   will need to run the program configuration to create the proper control
  261.   files and node work directories. The only thing left to do after that
  262.   is create batch files for each node.
  263.  
  264. ───────────────────────────────────────────────────────────────────────────────
  265.  
  266.   TROUBLESHOOTING:
  267.   ----------------
  268.  
  269.  1. This door DOES NOT REQUIRE a fossil driver to run correctly. However,
  270.     if you are running a DigiBoard or similar intelligent I/O card, a
  271.     fossil must be loaded so the door can get all of the proper serial
  272.     port information.
  273.  
  274.  2. If you are running a high speed modem (9600 baud or above), then I
  275.     suggest you run your BBS/Mailer/Doors at a locked baud rate. On high
  276.     speed error correcting modems, locking the baud rate will have a
  277.     noticable increase on the speed of text that is sent. It's beyond
  278.     the scope of this document to discuss configuring your BBS and
  279.     mailer for a locked baud rate, you may wish to consult your BBS docs
  280.     for information on that. Here are a couple things to keep in mind
  281.     when setting up door with a locked baud rate:
  282.  
  283.     a.  If you are using a fossil, then make sure to tell the fossil
  284.         that the port is locked. For BNU, to lock com1: at 38,400, you
  285.         would use something like "L0=38400,8N1" on BNU's command line.
  286.  
  287.     b.  If you lock the baud for one program, it must be locked for
  288.         everything. You can't lock the baud for just this door, but
  289.         not your BBS/Mailer.
  290.  
  291.     c.  If you are using a fossil driver, do not lock your port at any
  292.         rate higher than 38400 Baud. The fossil standards do not provide
  293.         for baud rates higher than 38400 baud. If you do lock your port
  294.         higher than this, then it would be best to disable your fossil
  295.         driver before running this door to ensure proper operation.
  296.  
  297.  3. What follows is some information on possible strange situations
  298.     that may occur on som systems:
  299.  
  300.     a.  Low speed users can use the door, but high speed users get garbage.
  301.  
  302.         - If you are the DORINFOx.DEF drop file, then there is a chance
  303.           your BBS is writing the locked port speed to the drop file
  304.           rather than the actual caller baud rate. You should either
  305.           change to the DOOR.SYS drop file, or use the /S parameter to
  306.           pass the actual baud rate to the door.
  307.  
  308.           Several converter programs are readily available on most
  309.           BBS systems. CallDoor is a good one if you can find it.
  310.  
  311.     b.  The door hangs up when a user enters the door.
  312.  
  313.         - Sounds like the door is getting the wrong baud rate somehow.
  314.           Try switching over to the DOOR.SYS drop file method if possible.
  315.  
  316.         - This can also be cause by using a fossil driver and locking the
  317.           comport at a rate higher than 38400. If this is the case, then
  318.           reduce your locked port speed and try again.
  319.  
  320.     c.  Text and screens are getting cut off.
  321.  
  322.         - If you are running with a locked baud, then this could be caused
  323.           by some sort of FLOW CONTROL problem. Make sure your fossil is
  324.           loaded correctly and not locked faster than 38400 baud.
  325.  
  326.         - If you're using something other than the DOOR.SYS drop file,
  327.           then I always suggest trying to use DOOR.SYS if possible. It is
  328.           the most reliable method and has had the most testing. If that
  329.           is not possible try DORINFOx.DEF as an alternative.
  330.  
  331.     d.  The door locks up the BBS on every node.
  332.  
  333.         - This can happen with fossil driver or the internal communications
  334.           routines because it uses the default comport of 1 when NONE or
  335.           COM0: is found in the drop file.
  336.  
  337.     e.  ANSI is reflected correctly on the local screen but the user is
  338.         getting garbage when using DORINFOx.DEF.
  339.  
  340.         - Assuming the user has ANSI installed then most likely the problem
  341.           is at your end. First make sure the dropfile is passing the actual
  342.           baud rate INSTEAD of the locked port speed. If it is not passing
  343.           correct baud rate then you may need to use DOOR.SYS instead.
  344.  
  345.     f.  When a user enters the door or when you run it locally, the screen
  346.         appears to cycle (flipping) over and over until the program shuts
  347.         down with a "Runtime Error 202".
  348.  
  349.         - This is caused by people running hacked versions of their fossil
  350.           driver. Even though most of these hacks are nothing more than a
  351.           copy with a new version number, once it's tampered with, it's a
  352.           defective copy. Programs to avoid are BNU 2.xx and X00 2.xx. If
  353.           at all possible, get your fossil drivers author direct!
  354.  
  355.